Fix PHPStan level 0 issues in themes by westonruter · Pull Request #10951 · WordPress/wordpress-develop

westonruter · 2026-02-17T02:20:40Z

The commits in this PR were cherry-picked from #10419 for Core-61175.

Trac ticket: https://core.trac.wordpress.org/ticket/64238

Use of AI Tools

n/a

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

…ia cast

github-actions · 2026-02-17T02:20:49Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props westonruter, sabernhardt.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

westonruter · 2026-02-17T02:22:51Z

@sabernhardt Would you review when you get a chance?

github-actions · 2026-02-17T02:33:01Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

sabernhardt · 2026-02-17T14:25:16Z

src/wp-content/themes/twentyfourteen/inc/featured-content.php

 	 *
 	 * @param WP_Query $query WP_Query object.
-	 * @return WP_Query Possibly-modified WP_Query.
+	 * @return void


This seems right. For history, this was already in r25808, when the Featured_Content class was added.

sabernhardt · 2026-02-17T14:29:27Z

src/wp-content/themes/twentytwenty/inc/template-tags.php

 * @param int    $post_id  The ID of the post.
 * @param string $location The location where the meta is shown.
- * @return string Post meta HTML.
+ * @return string|void Post meta HTML.


This function can return void in two situations, but I think returning an empty string could be better when there is no HTML to return. Maybe it's unwise to change that now, though.

Yeah, for this it seems best to document the existing behavior.

sabernhardt · 2026-02-17T14:32:19Z

src/wp-content/themes/twentytwentyone/classes/class-twenty-twenty-one-svg-icons.php

 			$repl = sprintf( '<svg class="svg-icon" width="%d" height="%d" aria-hidden="true" role="img" focusable="false" ', $size, $size );

-			$svg = preg_replace( '/^<svg /', $repl, trim( $arr[ $icon ] ) ); // Add extra attributes to SVG code.
+			$svg = (string) preg_replace( '/^<svg /', $repl, trim( $arr[ $icon ] ) ); // Add extra attributes to SVG code.


The pattern and $repl are both strings. If $arr[ $icon ] is somehow not a string, then it will have errors with the trim() function.

Suggested change

$svg = (string) preg_replace( '/^<svg /', $repl, trim( $arr[ $icon ] ) ); // Add extra attributes to SVG code.

$svg = preg_replace( '/^<svg /', $repl, trim( (string) $arr[ $icon ] ) ); // Add extra attributes to SVG code.

The issue that PHPStan is warning about is that preg_replace() can return false. So then we'd need to add two casts. However, what about cfb02ce? This ensures the proper type up front.

Yes, I prefer checking is_string( $arr[ $icon ] ) instead of casting it.

if ( isset( $arr[ $icon ] ) && is_string( $arr[ $icon ] ) ) { approach make sense here

sabernhardt · 2026-02-17T14:33:28Z

src/wp-includes/class-wp-theme.php

+	 *
+	 * @phpstan-return (
+	 *     $header is 'Tags'
+	 *         ? string[]|false
+	 *         : ( $header is 'Name'|'ThemeURI'|'Description'|'Author'|'AuthorURI'|'Version'|'Template'|'Status'|'TextDomain'|'DomainPath'|'RequiresWP'|'RequiresPHP'|'UpdateURI'
+	 *             ? string|false
+	 *             : false )
+	 * )


Does class-wp-theme.php belong in this PR?

Yes, because it fixes issues with calls to wp_get_theme()->get( 'Version' ).

For example:

wordpress-develop/src/wp-content/themes/twentytwentyone/functions.php

Line 391 in 8f6d312

wp_enqueue_style( 'twenty-twenty-one-style', get_template_directory_uri() . '/style.css', array(), wp_get_theme()->get( 'Version' ) );

PHPStan is flagging this:

Parameter #4 $ver of function wp_enqueue_style expects bool|string|null, array|string|false given.

With the inclusion of the @phpstan-return, the issue is resolved.

westonruter · 2026-02-18T03:28:31Z

@sabernhardt anything else you'd like revised?

sabernhardt · 2026-02-18T07:05:47Z

I have nothing further.

… comments. Developed in #10951 Props westonruter, sabernhardt, justlevine. See #64238, #61175. git-svn-id: https://develop.svn.wordpress.org/trunk@61676 602fd350-edb4-49c9-b593-d223f7449a82

westonruter · 2026-02-18T16:47:47Z

Committed in r61676 (265fbb4)

… comments. Developed in WordPress/wordpress-develop#10951 Props westonruter, sabernhardt, justlevine. See #64238, #61175. Built from https://develop.svn.wordpress.org/trunk@61676 git-svn-id: http://core.svn.wordpress.org/trunk@60984 1a063a9b-81f0-0310-95a4-ce76da25c4cd

westonruter added 6 commits February 16, 2026 18:16

Fix return types for core themes

c1b4653

Add variable return type for WP_Theme::get()

417f257

Ensure Customizer setting exists before setting transport to postMessage

2edcfeb

Pass empty strings instead of null in twenty_twenty_one_generate_css()

fe5cc0f

Ensure Twenty_Twenty_One_SVG_Icons::get_svg() always returns string v…

3d0b3e9

…ia cast

Improve placement and formatting of phpstan-return

2848245

westonruter mentioned this pull request Feb 17, 2026

Tests / Build Scripts: Configure PHPStan level 0 #10419

Open

sabernhardt reviewed Feb 17, 2026

View reviewed changes

Ensure SVG icon is a string

cfb02ce

westonruter closed this Feb 18, 2026

	$svg = (string) preg_replace( '/^<svg /', $repl, trim( $arr[ $icon ] ) ); // Add extra attributes to SVG code.
	$svg = preg_replace( '/^<svg /', $repl, trim( (string) $arr[ $icon ] ) ); // Add extra attributes to SVG code.

Conversation

westonruter commented Feb 17, 2026

Use of AI Tools

Uh oh!

github-actions bot commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

westonruter commented Feb 17, 2026

Uh oh!

github-actions bot commented Feb 17, 2026

Test using WordPress Playground

Some things to be aware of

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sabernhardt Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

westonruter Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

westonruter commented Feb 18, 2026

Uh oh!

sabernhardt commented Feb 18, 2026

Uh oh!

westonruter commented Feb 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

github-actions bot commented Feb 17, 2026 •

edited

Loading

sabernhardt Feb 17, 2026 •

edited

Loading

westonruter Feb 17, 2026 •

edited

Loading